home *** CD-ROM | disk | FTP | other *** search
/ Gold Medal Software 3 / Gold Medal Software - Volume 3 (Gold Medal) (1994).iso / archive / rvs112.arj / RVS.DOC < prev    next >
Text File  |  1994-03-06  |  11KB  |  257 lines
  1. RVS-RView Shell, Version 1.12                           06-Mar-94
  2.  
  3.  
  4. Shell for viewing and extracting the contents of several archive types.
  5. Calls on user-selectable external programs to extract and view.  Currently
  6. supported are ARC, ARJ, HYP, LZH, LZS, PAK, SQZ, ZIP and ZOO.  Displays
  7. either ZIP- or LZH-style compression ratios.  Various sort options.
  8.  
  9. Contents:
  10. =========
  11. Purpose
  12. Display
  13. Syntax
  14. Switches
  15. Configuration
  16. Commands
  17. Pull-down menus
  18. Contact
  19.  
  20. Purpose:
  21. ========
  22. I've never been a fan of any of the existing archive shells.  No criticism
  23. intended, simply a matter of taste.  On the other hand, there are times when
  24. I find my own command-line RView program (RV) inappropriate.  Thus, I
  25. designed RVS to complement my use of RV, and to work the way I want it to. 
  26. My preferences probably don't even remotely resemble those of the
  27. mainstream, so I don't expect RVS to become a mainstream archive shell. 
  28. It's a program which I find useful, and I offer it to others who may want to
  29. share its use with me.
  30.  
  31. Since filename extensions are ignored in determining archive types, this
  32. program may be used to determine the type of archive if the filename
  33. extension is missing, or inappropriate.
  34.  
  35. RVS is a free program.
  36.  
  37. Display:
  38. ========
  39. The program displays either in color or "black-and-white" based on the video
  40. mode at program start-up.  However, if the user has a color graphics card,
  41. but no color monitor, the display may be improved by using the DOS command
  42. "MODE BW80".  Conversely, color mode may be forced on by using "MODE CO80".
  43.  
  44. A command-line switch is also available to force black-and-white mode (see
  45. "Switches").
  46.  
  47. EGA/43- and VGA/50-line modes are supported.  At program start-up, an
  48. attempt is made to detect the actual number of lines on the screen, up to a
  49. maximum of 50, and to adjust the display accordingly.
  50.  
  51. Refer to RV.DOC, distributed with the current release of RV, for a
  52. discussion of RV's display (similar to that of RVS).
  53.  
  54. When viewing directories within archives, a two character indicator on the
  55. right of the top status line shows both the type and sense of the sort.  The
  56. first character is N/E/D/O/P/R/U with the same meaning as for the /Sx
  57. command-line switches (below).  The second character is either a '+' or a
  58. '-' to indicate Ascending or Descending, respectively.
  59.  
  60. Syntax:
  61. =======
  62.  
  63.         Usage:  RVS [switches] [filespec]
  64.  
  65. If no extension is specified for "filespec", ".*" is assumed.  If a valid
  66. filename is specified unambiguously, the file is immediately displayed. 
  67. Either specifying "filespec" using wildcards, or specifying a drive or
  68. directory name causes a scrollable directory window to pop up.  Simply
  69. typing the program name is the same as specifying "*.*".
  70.  
  71.         Examples:       RVS C:          <- current directory of drive C:
  72.                         RVS D:\         <- root of drive D:
  73.                         RVS \PCPLUS\DL  <- DL subdirectory of \PCPLUS
  74.  
  75. Switches:
  76. =========
  77.  
  78. /A        Alternate compression ratio.  ZIP-style compression ratios are
  79.           displayed by default.  Use this switch to display LZH-style
  80.           ratios.  (Tip:  Include this switch in RVS.CFG to always display
  81.           LZH-style ratios.)
  82.  
  83. /BW       Black-and-White mode.  Provided as an alternative to using DOS's
  84.           "MODE BW80" command.
  85.  
  86. /Fx       Where 'x' represents 0/1/2/3, as follows:
  87.  
  88.           F0 - don't filter (fastest/default)
  89.           F1 - check only for normal archive extensions
  90.           F2 - same as F1, but do a thorough check of .COM and .EXE files
  91.           F3 - check all files for valid archives (slowest)
  92.  
  93. /O[path]  Output path for extractions ("out_path").  For use in conjunction
  94.           with the "%o" format specifier (see "Configuration").  If no path
  95.           is specified, the current directory is used.  Also specifies which
  96.           directory to use for temporary extractions when viewing, if /T is
  97.           not used.
  98.  
  99. /Sx[-]    Where 'x' represents N/E/D/O/P/R/U, as follows:
  100.  
  101.           SN - Sort by Name (default)
  102.           SE - Sort by Extension
  103.           SD - Sort by Date/time
  104.           SO - Sort by Original size
  105.           SP - Sort by Packed size
  106.           SR - Sort by compression Ratio
  107.           SU - leave Unsorted
  108.  
  109.           Appending a hyphen '-' to the above switches will reverse the
  110.           sense of the sort from ascending to descending.
  111.  
  112. /T[path]  Temporary extraction path for viewing ("temp_path").  For use in
  113.           conjunction with the "%o" format specifier (see "Configuration"). 
  114.           This could point to a RAM-disk, for instance.  This overrides the
  115.           directory implied by the "/O" switch when viewing.
  116.  
  117. Tip:  When using the /O or /T switch, it might be better to end each "path"
  118. designation with a backslash, '\'.  Note that, if "C:\TEMP" is the name of
  119. your temporary extraction directory, "PKUNZIP archive.zip D:\temp" will work
  120. but "LHA e archive.lzh D:\temp" will not.  For LHA, the trailing backslash
  121. is mandatory.
  122.  
  123. Either '/' or '-' may be used to specify switches.
  124.  
  125. Entering an invalid switch causes the program to display a brief help screen
  126. then exit.
  127.  
  128.         Examples:       RVS /h
  129.                         RVS -?
  130.  
  131. Configuration:
  132. ==============
  133. An optional configuration file containing user-selected default switches may
  134. be created or edited with any editor or word processor which can save pure
  135. ASCII text files.  This file should be named "RVS.CFG" and placed in the
  136. same directory from which RVS.EXE will be loaded (DOS 3.0 and above).
  137.  
  138. Switches, including switch options, may be separated by spaces or placed on
  139. separate lines.
  140.  
  141. In addition to specifying "true" switches, RVS.CFG should also contain lines
  142. assigning which commands to use for viewing extracted files, and which
  143. commands to use for extracting files from archives.
  144.  
  145. The syntax for assigning the view commands is:
  146.  
  147. /V[ext]="command"
  148.  
  149. Where:  "ext" is an optional filename to link to a view command.  If
  150.           omitted, then the associated command is the default viewer for
  151.           unmatched extensions.
  152.  
  153.         "command" should be set to the command line, including arguments, of
  154.           the view command you wish to run.
  155.  
  156. There may be several assignments of view commands in RVS.CFG, each linking a
  157. different filename extension with a different command.  Specifying
  158. extensions is optional.  A view assignment with no extension, i.e.
  159. "/V="command" tells the program which viewer to use if the selected file's
  160. extension isn't linked to a specific view command.
  161.  
  162. Tip:  A maybe subtle consequence of this option to specify viewers based on
  163. extensions is that RVS is able to "recurse" through archives included within
  164. other archives, if "RVS %f" is linked to the appropriate archive extensions. 
  165. This capability may be limited by memory constraints.
  166.  
  167. "Command" should at least include the "%f" format specifier, which
  168. represents the currently highlighted compressed file.
  169.  
  170. Example:        /V="LIST %f"
  171.  
  172. The syntax for assigning the extract commands is:
  173.  
  174. /E<xxx>="command"
  175.  
  176. Where:  "<xxx>" is "arc", "arj", "lzh", "lzs", "pak", "zip" or "zoo".
  177.  
  178.         "command" should be set to the command line, including arguments, of
  179.           the extraction command you wish to run for that archive type.
  180.  
  181. "Command" would typically include both the "%a" and "%f" format specifiers,
  182. which represent the archive name and selected compressed file, respectively.
  183.  
  184. The "%o" format specifier may also be embedded in extract commands.  It
  185. indicates where in "command" either "out_path" or "temp_path" (see
  186. "Switches") should be inserted when "command" is executed.  Please bear in
  187. mind that some unarchivers may not support redirection of extractions to
  188. different drives or directories.
  189.  
  190.         Examples:       /Earj="ARJ e %a %f"
  191.                         /Elzh="LHA e %a %o %f"
  192.                         /Ezip="PKUNZIP %a %o %f"
  193.  
  194. True switches should be placed on separate lines from those assigning
  195. commands.
  196.  
  197. Incompatible switches used on the command line will override switches
  198. included in RVS.CFG.  Switches are evaluated from left to right.
  199.  
  200. A sample RVS.CFG file is included in the distribution archive for RVS, which
  201. the user may edit to "customize" RVS's behavior.
  202.  
  203. Commands:
  204. =========
  205. While viewing the contents of an archive, the following commands may be
  206. used:
  207.  
  208. Pressing <F1> or the letter 'H' will display a brief help screen summarizing
  209. commonly used commands.  Press any key to close the help window.
  210.  
  211. Pressing <F2> or the letter 'X' will cause the currently selected file(s) to
  212. be eXtracted by the appropriate extraction program specified in RVS.CFG.
  213.  
  214. By "currently selected" is meant either any tagged files, or the currently
  215. highlighted file, if no files are tagged.
  216.  
  217. Files may be tagged either individually or by wildcard selection.  The <Ins>
  218. key may be used as a toggle to select and unselect individual files. 
  219. Pressing <Ins> on an unselected file selects it.  Pressing <Ins> on a
  220. selected file unselects it.  To select a group of files using DOS-type
  221. wildcards, press the plus ('+') key.  This opens up an input window into
  222. which a file specification may be entered.  To unselect a group of files,
  223. press the minus ('-').  This opens up an input window similar to the one for
  224. selection.  The suggested keys are the gray plus and minus keys found near
  225. the numeric keypad of many keyboards.
  226.  
  227. Pressing <F3> or the letter 'V' will cause the currently highlighted file to
  228. be extracted and displayed by the appropriate commands specified in RVS.CFG. 
  229. The extracted file will be erased after exiting the view program.
  230.  
  231. Pressing <F4> or the letter 'T' will toggle the display between the default
  232. listing and one showing full pathnames.  This command is only available for
  233. supported archives types with paths stored.
  234.  
  235. Pressing <F5> or the letter 'O' will allow the user to edit "out_path" on
  236. the fly.  Useful for temporarily overriding the /O switch setting specified
  237. either in RVS.CFG or from the command line.
  238.  
  239. Pressing <F9> or the letter 'P' or '/' will invoke the pull-down menu
  240. system.
  241.  
  242. Pressing <Esc>, <F10> or the letter 'Q' will exit the program.
  243.  
  244. Pull-down menus:
  245. ================
  246. Listings may be sorted on-the-fly from the "Display" pop-up.  Listings may
  247. be sorted by Name, Extension, Date/time, Original size, Packed size,
  248. compression Ratio, or left Unsorted.  Listings are sorted in Ascending order
  249. by default, but the sense of the sort may be reversed from within this menu.
  250.  
  251. Contact:
  252. ========
  253.  
  254.     Raymond T. Kaya        CompuServe:  71230,2500
  255.     P. O. Box 1436        Internet:  71230.2500@compuserve.com
  256.     Honolulu, HI  96806
  257.